FormManagerAPI Methods
An object defining methods for the FormManagerAPI class.
Run(formInstance, cancellationToken, telemetryCollectorHolder)
Executes the specified form instance.
Parameters:
formInstance (required): FormInstance
The form instance that will be executed.
cancellationToken (optional): CancellationToken
A cancellation token that can be used to cancel the asynchronous operation.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data. This property is advanced and primarily for internal telemetry purposes.
Returns:
Type: Task<FormRunResponse>
Returns the result of the form execution.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
Save(formInstance, cancellationToken, telemetryCollectorHolder)
Saves the specified form instance.
Parameters:
formInstance (required): FormInstance
Saves the current form instance.
cancellationToken (optional): CancellationToken
A cancellation token that can be used to cancel the asynchronous operation.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data. This property is advanced and primarily for internal telemetry purposes.
Returns:
Type: Task<FormSaveResponse>
Returns the result of the form save operation.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
GetControlValue(projectName, formName, documentId, controlName, cancellationToken, telemetryCollectorHolder)
Retrieves the value of a specified control within a form instance.
Parameters:
projectName (required): string
The name of the project to which the form belongs.
formName (required): string
The name of the form containing the control.
documentId (required): long
The unique identifier of the document associated with the form instance.
controlName (required): string
The name of the control whose value is to be retrieved.
cancellationToken (optional): CancellationToken
A cancellation token that can be used to cancel the asynchronous operation.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data. This property is advanced and primarily for internal telemetry purposes.
Returns:
Type: Task<FormGetControlValueResponse>
Returns the value of the specified control.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
SetUrl(url)
Sets the API URL for requests.
Parameters:
url (required): string
The new API URL.
Returns:
Type: void
Method does not return anything
Exceptions:
Type: ArgumentNullException
ThrowsArgumentNullExceptionif URL is null or empty.
Type: Exception
ThrowsExceptionif the URL is invalid.
This is a sync method. Method runs synchronously.
CheckColumnsIsUnique(projectName, formName, documentId, controlName, rows, telemetryCollectorHolder)
Checks if the specified columns are unique within a set of rows in a grid control.
Parameters:
projectName (required): string
The name of the project to which the form belongs.
formName (required): string
The name of the form containing the grid control.
documentId (optional): long?
The unique identifier of the document associated with the form instance. Can benull.
controlName (required): string
The name of the grid control to be checked for unique columns.
rows (required): List<GridDataRow>
A list of rows to be checked for column uniqueness.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data. This property is advanced and primarily for internal telemetry purposes.
Returns:
Type: Task<CheckColumnsIsUniqueResponse>
Returns aCheckColumnsIsUniqueResponseobject containing the results of the column uniqueness check.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
UpdateStatus(projectName, formName, documentId, status, telemetryCollectorHolder)
Updates the status of a specified document associated with a form instance.
Parameters:
projectName (required): string
The name of the project to which the form belongs.
formName (required): string
The name of the form whose document status is to be updated.
documentId (required): long
The unique identifier of the document whose status is to be updated.
status (required): int
The new status value to set for the document.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data. This property is advanced and primarily for internal telemetry purposes.
Returns:
Type: Task<bool>
Returnstrueif the status was successfully updated; otherwise,false.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
Create(projectName, formName, secretKey, cancellationToken, telemetryCollectorHolder)
Creates a new form instance.
Parameters:
projectName (required): string
The name of the project to which the form to be created belongs.
formName (required): string
The name of the form to be created.
secretKey (required): string
The name of the form to be created.
cancellationToken (optional): CancellationToken
A cancellation token that can be used to cancel the asynchronous operation.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data. This property is advance using only.
Returns:
Type: Task<FormInstance>
Returns the created form instance.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
Create(projectName, formName, documentId, readOnly, view, validate, parameters, cancellationToken, telemetryCollectorHolder)
Creates a new form instance with specified configurations.
Parameters:
projectName (required): string
The name of the project to which the form to be created belongs.
formName (required): string
The name of the form to be created.
documentId (required): long
The unique identifier of the document associated with the form instance.
readOnly (optional): bool
Specifies if the form instance should be created in read-only mode. Default isfalse.
view (optional): string
The view associated with the form instance, if any. Default is an empty string.
validate (optional): bool
Determines if the form instance should undergo validation. Default istrue.
parameters (optional): Dictionary<string, object>
A dictionary of key-value pairs providing additional parameters for the form instance. Default isnull.
cancellationToken (optional): CancellationToken
A cancellation token that can be used to cancel the asynchronous operation.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data. This property is advanced and primarily for internal telemetry purposes.
Returns:
Type: Task<FormInstance>
Returns the newly created form instance.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
SetUniqueId(projectName, formName, documentId, readOnly, view, validate, parameters, cancellationToken, telemetryCollectorHolder)
Sets a unique identifier for a specified form instance.
Parameters:
projectName (required): string
The name of the project to which the form belongs.
formName (required): string
The name of the form instance for which the unique identifier is to be set.
documentId (required): long
The unique identifier of the document associated with the form instance.
readOnly (optional): bool
Specifies if the form instance should be created in read-only mode. Default isfalse.
view (optional): string
The view associated with the form instance, if any. Default is an empty string.
validate (optional): bool
Determines if the form instance should undergo validation. Default istrue.
uniqueId (optional): string
The unique identifier to set for the form instance. Default is an empty string.
parameters (optional): Dictionary<string, object>
A dictionary of key-value pairs providing additional parameters for the form instance. Default isnull.
cancellationToken (optional): CancellationToken
A cancellation token that can be used to cancel the asynchronous operation.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data. This property is advanced and primarily for internal telemetry purposes.
Returns:
Type: Task<bool>
Returns a boolean value indicating whether the unique identifier was successfully set for the form instance.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
SaveAsDraft(formInstance, starterInfo, cancellationToken, telemetryCollectorHolder)
Saves the form instance as a draft.
Parameters:
formInstance (required): FormInstance
The form instance that will be saved as a draft.
starterInfo (required): FormStarterInfo
The starter information needed to save the form instance as a draft.
cancellationToken (optional): CancellationToken
A cancellation token that can be used to cancel the asynchronous operation.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data. This property is advanced and primarily for internal telemetry purposes.
Returns:
Type: Task<FormSaveAsDraftResponse>
Returns the result of the form save as draft operation.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
CreateWithoutView(projectName, formName, cancellationToken, telemetryCollectorHolder)
Creates a new form instance without initializing the view.
Parameters:
projectName (required): string
The name of the project to which the form to be created belongs.
formName (required): string
The name of the form to be created.
cancellationToken (optional): CancellationToken
A cancellation token that can be used to cancel the asynchronous operation.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data. This property is advanced and primarily for internal telemetry purposes.
Returns:
Type: Task<FormInstance>
Returns the created form instance.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
CreateWithoutView(projectName, formName, documentId, readOnly, view, validate, parameters, cancellationToken, telemetryCollectorHolder)
Creates a new form instance without initializing the view, with additional configurations.
Parameters:
projectName (required): string
The name of the project to which the form to be created belongs.
formName (required): string
The name of the form to be created.
documentId (required): long
The unique identifier of the document associated with the form instance.
readOnly (optional): bool
Specifies if the form instance should be created in read-only mode. Default isfalse.
view (optional): string
The view associated with the form instance, if any. Default is an empty string.
validate (optional): bool
Determines if the form instance should undergo validation. Default istrue.
parameters (optional): Dictionary<string, object>
A dictionary of key-value pairs providing additional parameters for the form instance. Default isnull.
cancellationToken (optional): CancellationToken
A cancellation token that can be used to cancel the asynchronous operation.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data. This property is advanced and primarily for internal telemetry purposes.
Returns:
Type: Task<FormInstance>
Returns the newly created form instance.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
UpdateFormData(projectName, formName, formData, telemetryCollectorHolder)
Updates the form data for a specified form instance.
Parameters:
projectName (required): string
The name of the project to which the form belongs.
formName (required): string
The name of the form whose data is to be updated.
formData (required): FormData
The form data object containing updated control values and a secret key.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data. This property is advanced and primarily for internal telemetry purposes.
Returns:
Type: Task<FormSaveResponse>
Returns a task representing the asynchronous operation. The task result contains a response object that includes the number of successfully updated form instances.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
CreateWithDocumentData(projectName, formName, documentData, telemetryCollectorHolder)
Creates a new form instance with the specified document data.
Parameters:
projectName (required): string
The name of the project to which the form belongs.
formName (required): string
The name of the form to be created with document data.
documentData (required): FormDocumentData
The document data used to populate the form instance.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data. This property is advanced and primarily for internal telemetry purposes.
Returns:
Type: Task<FormCreateWithDocumentDataResponse>
Returns a task representing the asynchronous operation. The task result contains a response object that includes the form instance ID and the number of successfully created form instances.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
DeleteDocument(projectName, formName, documentId, telemetryCollectorHolder)
Deletes a document associated with a specified form instance.
Parameters:
projectName (required): string
The name of the project to which the form belongs.
formName (required): string
The name of the form from which the document is to be deleted.
documentId (required): long
The unique identifier of the document to be deleted.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data. This property is advanced and primarily for internal telemetry purposes.
Returns:
Type: Task<bool>
Returnstrueif the document was successfully deleted; otherwise,false.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
GetFormData(projectName, formName, secretKey, telemetryCollectorHolder)
Retrieves form data for a specified form instance using a secret key.
Parameters:
projectName (required): string
The name of the project to which the form belongs.
formName (required): string
The name of the form for which data is to be retrieved.
secretKey (required): string
A secret key used to access the form instance.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data. This property is advanced and primarily for internal telemetry purposes.
Returns:
Type: Task<FormData>
Returns the form data object containing control values and a secret key.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
BatchCreateWithDocumentData(projectName, formName, documentsData, telemetryCollectorHolder)
Creates multiple form instances with the specified document data in batch.
Parameters:
projectName (required): string
The name of the project to which the forms belong.
formName (required): string
The name of the form to be created in batch with document data.
documentsData (required): List<FormDocumentData>
A list of document data objects used to populate multiple form instances.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data. This property is advanced and primarily for internal telemetry purposes.
Returns:
Type: Task<FormBatchCreateWithDocumentDataResponse>
Returns a task representing the asynchronous operation. The task result contains a response object that includes the form instance IDs and the number of successfully created form instances.
This is a async method. Method should be waited. Be careful if call this method without waiting.